Skip to content

Conversation

@sofiia-chorna
Copy link
Contributor

@sofiia-chorna sofiia-chorna commented Oct 28, 2025

  • Fixed parameter descriptions, added missing parameter description
  • Moved duplicated code to the separate function
  • Replaced assert with raised errors

Contributor (creator of PR) checklist

  • Tests updated (for new features and bugfixes)?
  • Documentation updated (for new features)?
  • Issue referenced (for PRs that solve an issue)?

For Reviewer

  • CHANGELOG updated if important change?

📚 Documentation preview 📚: https://scikit-matter--275.org.readthedocs.build/en/275/

Copy link
Collaborator

@PicoCentauri PicoCentauri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for the cleanup!

Can you maybe highlight the None as with backticks? I found a couple but probably I missed some.

Also, we could check removing the default from the docstring, if the rendering is good enough.

Copy link
Collaborator

@PicoCentauri PicoCentauri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful. Just a small test and we can merge.

Copy link
Collaborator

@PicoCentauri PicoCentauri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Thanks @sofiia-chorna for your first commit to scikit-matter 🚀

@PicoCentauri PicoCentauri merged commit 108ce37 into scikit-learn-contrib:main Oct 29, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants